ソフトバンクまとめて支払い

ソフトバンクまとめて支払い(継続決済) API一覧

※idPass版にのみ対応しています。json版には対応しておりません。

HTTP仕様（.idPass）

Request header
Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method
POST
Response header
Content-Type: text/plain;charset=windows-31j
Status Code
200：常に200を返却

EntryTranSbContinuance 取引登録

これ以降の決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

　
ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

Amount 必須 半角数字6桁
利用金額

Tax 半角数字5桁
税送料

税送料を指定した場合は、利用金額＋税送料が決済金額となります。
利用金額＋税送料で1円以上100,000円／月以下である必要があります。
ソフトバンクまとめて支払い（B）の利用限度額はお客様の契約期間や年齢によって変わってきます。詳細はソフトバンクサイトでご確認ください。

URL
/payment/EntryTranSbContinuance.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813
レスポンスパラメータ：異常系
ErrCode=M01&ErrInfo=M01002002

ExecTranSbContinuance 決済実行

これ以降の決済取引で必要となるトークンを返却します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

AccessID 必須 半角英数32桁 固定
取引ID

AccessPass 必須 半角英数32桁 固定
取引パスワード

OrderID 必須 半角英数記号27桁
オーダーID

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

RetURL 必須 半角英数記号256桁
決済結果戻しURL

加盟店様が当サービスからの決済結果を受信する為の結果受信URLを設定します。
ソフトバンクセンター上でお客様が決済手続きを正常に完了された場合に、指定されたURLに結果をリダイレクト経由で送信されます。
PaymentTermSec 半角数字5桁
支払開始期限秒

お客様が【決済実行】から【支払手続き開始IF】を呼び出すまでの期限です。
最大86,400秒（1日）
呼び出しパラメータが空の場合、120秒で処理されます。
ChargeDay 必須 半角数字2桁 固定
課金基準日

月々の継続課金を確定する日を指定します。
有効な日付は10,15,20,25,31です。
尚、31の場合は毎月月末に継続課金データを確定します。
FirstMonthFreeFlag 必須 半角数字1桁 固定
初月無料フラグ

継続課金申込時に課金するかを指定します。
0：課金する
1：課金しない（申込みのみ）

URL
/payment/ExecTranSbContinuance.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&RetURL=https://example.com/receive&ChargeDay=10&FirstMonthFreeFlag=0
レスポンス
正常
AccessID 半角英数32桁 固定
取引ID

Token 半角英数256桁 固定
トークン

アクセスIDのハッシュ値を返却します。
StartURL 半角英数記号256桁
支払手続き開始 IFのURL

支払手続き開始IFのURLを返却します。
StartLimitDate 半角数字14桁 固定
支払開始期限日時

支払手続き開始IFの呼び出し期限を返却します。
yyyyMMddHHmmss書式
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=7zTgGKeccFSXt1GD2aA0aO1NpliOjXE9kynelaJET0SwBS7yYvxSiC0zeMVH+O4F&StartURL=https://x01.mul-pay.jp/payment/SbContinuanceStart.idPass&StartLimitDate=20221027155016
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SbContinuanceStart 支払い手続き開始

お客様をソフトバンクセンターへ誘導します。
※取引が特定できない場合、すでに支払いを済ませている場合、支払期限切れの場合等はエラー画面を表示します。

リクエスト
AccessID accessID 必須 半角英数32桁 固定
取引ID

Token token 必須 半角英数256桁 固定
トークン

【決済実行】で発行された値を設定します。

URL
/payment/SbContinuanceStart.json
リクエストパラメータ
{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "token": "7zTgGKeccFSXt1GD2aA0aO1NpliOjXE9kynelaJET0SwBS7yYvxSiC0zeMVH+O4F"
}
URL
/payment/SbContinuanceStart.idPass
リクエストパラメータ
AccessID=a6a6b0061347e90cdef806b39bd28705&Token=7zTgGKeccFSXt1GD2aA0aO1NpliOjXE9kynelaJET0SwBS7yYvxSiC0zeMVH+O4F
リダイレクトページサンプル

<html>
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=Windows-31J">
  </head>
  <body OnLoad='OnLoadEvent();'>
    <form name="SbContinuanceStartCall" action="{SbContinuanceStartURL}" method="POST">
    <noscript>
      <center>
        <h2>ソフトバンクまとめて支払い（B）の決済画面へ遷移します。</h2>
        <input type="submit" value="続行">
      </center>
      </noscript>
      <input type="hidden" name="AccessID" value="{AccessID}">
      <input type="hidden" name="Token" value="{Token}">
    </form>
    <script >
    <!--
      function OnLoadEvent() {
        document.SbContinuanceStartCall.submit();
      }
    //-->
    </script>
  </body>
</html>

リダイレクト後、お客様はソフトバンクまとめて支払い（B）の画面へ遷移します。

登録結果受信

ソフトバンクセンターから、当サービスに認証・登録操作結果が通知されます。
認証・登録操作結果は、お客様が登録操作を完了した場合と認証・登録操作をキャンセルした場合に通知されます。
当サービスは、【決済実行】時に指定されたリダイレクトURLに登録結果を通知します。
この登録結果は、ソフトバンクセンターの登録完了画面からブラウザ経由で連携されるため、ユーザの操作方法によっては登録操作が完了したにもかかわらず、加盟店様に通知されないことがあります。その際はショップ管理画面または結果通知にて確認ください。また、同様の理由でこの登録結果が複数回加盟店様に通知されることがあります。

レスポンス
正常
ShopID shopID 半角英数13桁 固定
ショップID

OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

該当取引の取引状態を返却します。
REGISTER：継続課金登録
PAYFAIL：継続課金登録失敗
AUTHCANCEL：認証処理キャンセル
TranDate tranDate 半角数字14桁 固定
処理日時

当サービスで処理を実施した日時を返却します。
yyyyMMddHHmmss書式
SbTrackingId sbTrackingId 半角英数14桁
ソフトバンク処理トラッキングID

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
ShopID=tshop11223344&OrderID=ORDER0000001&Status=REGISTER&TranDate=20220101000000&SbTrackingId=20220101000000
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SbContinuanceChargeCancel 課金データ取消

課金データの取消を行います。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

ContinuanceMonth continuanceMonth 必須 半角数字6桁
継続課金年月

取消する継続課金の年月をyyyyMM書式で指定してください。

URL
/payment/SbContinuanceChargeCancel.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "continuanceMonth": "202201"
}
URL
/payment/SbContinuanceChargeCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&ContinuanceMonth=202201
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

キャンセル成功時は以下のステータスが返却されます。
・CANCEL：課金要求取消
・RETURN：課金取消
取消失敗時は取消処理前のステータスのままとなります。

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "CANCEL"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SbContinuanceCancel 継続課金解約

継続課金登録した取引に対して解約を行います。

リクエスト
ShopID shopID 必須 半角英数13桁 固定
ショップID

ShopPass shopPass 必須 半角英数64桁
ショップパスワード

AccessID accessID 必須 半角英数32桁 固定
取引ID

AccessPass accessPass 必須 半角英数32桁 固定
取引パスワード

OrderID orderID 必須 半角英数記号27桁
オーダーID

URL
/payment/SbContinuanceCancel.json
リクエストパラメータ
{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}
URL
/payment/SbContinuanceCancel.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001
レスポンス
正常
OrderID orderID 半角英数記号27桁
オーダーID

Status status
現状態

解約成功時は以下のステータスが返却されます。
・CANCEL：継続課金解約

異常
ErrCode errCode 半角英数3桁 固定
エラーコード
ErrInfo errInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
{
  "orderID": "ORDER0000001",
  "status": "CANCEL"
}
レスポンスパラメータ：正常系
OrderID=ORDER0000001&Status=CANCEL
レスポンスパラメータ：異常系
{
    "errCode":"E01",
    "errInfo":"E01040001"
}
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引情報参照

対象取引の取引状態を取得します。

リクエスト
ShopID 必須 半角英数13桁 固定
ショップID

ShopPass 必須 半角英数64桁
ショップパスワード

OrderID 必須 半角英数記号27桁
オーダーID

PayType 必須 半角数字2桁
決済方法

22：ソフトバンクまとめて支払い（B）継続課金

URL
/payment/SearchTradeMulti.idPass
リクエストパラメータ
ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=22
レスポンス
正常
Status
現状態

UNPROCESSED：未決済
REQSUCCESS：要求成功
AUTHPROCESS：認証処理中
AUTHCANCEL：認証処理キャンセル
REGISTER：継続課金登録
PAYFAIL：継続課金登録失敗
EXPIRED：期限切れ
CANCEL：継続課金解約

ProcessDate 半角数字14桁 固定
処理日時

処理を実施した日時を返却します。
yyyyMMddHHmmss書式

JobCd
処理区分

CHARGE：課金申込
CANCEL：継続課金解約

AccessID 半角英数32桁 固定
取引ID

AccessPass 半角英数32桁 固定
取引パスワード

Amount 半角数字10桁
利用金額

Tax 半角数字10桁
税送料

ClientField1 全半角100バイト
加盟店自由項目1

ClientField2 全半角100バイト
加盟店自由項目2

ClientField3 全半角100バイト
加盟店自由項目3

PayType 半角数字2桁
決済方法

22：ソフトバンクまとめて支払い（B）継続課金
PaymentTerm 半角数字14桁 固定
支払期限日時

yyyyMMddHHmmss書式

SbTrackingId 半角英数14桁
ソフトバンク処理トラッキングID
SbStartChargeMonth 半角数字6桁
課金開始月

yyyyMM書式
異常
ErrCode 半角英数3桁 固定
エラーコード
ErrInfo 半角英数9桁 固定
エラー詳細コード
レスポンスパラメータ：正常系
Status=REGISTER&ProcessDate=20220808143025&JobCd=CHARGE&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=1000&Tax=0&ClientField1=&ClientField2=&ClientField3=&PayType=22&PaymentTerm=20220808153008&SbTrackingId=12345678901234&SbStartChargeMonth=202208
レスポンスパラメータ：異常系
ErrCode=E01&ErrInfo=E01040001